home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / util / cdity / ffind11.lha / FileFinder / File Finder.doc < prev    next >
Encoding:
Text File  |  1995-02-26  |  11.9 KB  |  334 lines

  1.  
  2.                                      File Finder 
  3.                          Release Version 1.1 26th Feb 1995 
  4.                              written by Mark Melton 
  5.                email u9326383@radon.sys.uea.ac.uk (until July 96)
  6.  
  7.  
  8.  Contents 
  9.  Copyright 
  10.  Introduction 
  11.  Requirements 
  12.  Installation 
  13.  Usage 
  14.  Problems
  15.  Future plans 
  16.  Acknowledgements 
  17.  Suggestions/Registration
  18.  
  19.                                          Copyright
  20.                                        ©1995 M.D. Melton
  21.  
  22. This product may be freely distributed as long as certain conditions are met.
  23.  
  24. 1. This product may only be distributed in a compleat form this doc file including copyright message  must be  i
  25. ncluded .
  26.  
  27. 2. This product may be freely distributed via the internet or any other non commercial venture.  
  28.  
  29. 3. This program my only be distributed by a commercial PD library only with my express
  30. permission, for  which a charge will be made.
  31.  
  32. 4. No charge may be made for the distribution of this product except for a nominal fee
  33. for the media on which it is transmitted, without my permission.
  34.  
  35. 5. This product may not be included on any magazine coverdisk without my written consent
  36. except for the Amiga Shopper magazine based in the UK.
  37.  
  38. 6. This product will not be included in any commercial package, unless my written consent
  39. is obtained before distribution.
  40.  
  41. By distributing, using or copying the product you indicate your acceptance of the above conditions.
  42.  
  43. Disclaimer
  44.  
  45. This program is provided as is, and no liability is accepted for any dammage caused to you, your  machine,  or f
  46. or that matter anything else. Hey if using this program causes WW3 don't blame me OK.
  47.  
  48.  
  49.  
  50.  
  51. Introduction
  52.  
  53. This program is used for finding things, still you probably worked that out from the name ;-). I wrote it mainly
  54. because I have access to several Amigas (TM), with rather large hard-drive's. I found there was a need to quickly
  55. find the location of file's on the machines as many of them have files stored in different ways. There was also
  56. the article in the Amiga Shopper magazine on a file finding utility.
  57. I modified their code a bit and added substantial amounts, and came up with this program.
  58.  
  59.  
  60. Current features in version 1.1
  61.  
  62. -> Find any file on a disk, using standard AmigaDos(TM) file matching patterns.
  63.  
  64. -> Fully implemented as a commodity, with user definable hotkey etc.
  65.  
  66. -> Limit search size parameters, only files in a certain size range are checked.
  67.  
  68. -> Limit date range parameters, only files in a ceratain date range are checked.
  69.  
  70. -> Window is now sizable.
  71.  
  72. -> Slightly faster search routine.
  73.  
  74. -> Interface is now an "AppWindow", when a file or directory is droped on the interface its path is entered in
  75. the path gadget.
  76.  
  77. + a few bug fixes.
  78.  
  79. -> Stack overflow fixed. Reported by millions (well at least four people :-)
  80.  
  81. -> GUI problems when running on non-interlaced NTSC machines fixed.  Reported by a NTSC A500 user, thanks!
  82.  
  83. -> Problems with SoftLinked directories fixed.  Well they now work on my machine, if you know different let me
  84. know ;-).
  85.  
  86. -> All gadget enteries are remembered even if GUI is hidden.
  87.  
  88. -> Close window gadget now "hides" the interface instead of closing it.
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95. Requirements for File Finder.
  96.  
  97. It is essential that you have at least kickstart & Workbench 2.04.
  98.  
  99. Other than that there are no further restrictions, well appart from having an amiga :-).
  100.  
  101. The program has been written on an A1200 with 50MhzGVP A1230-II. It has been tested using enforcer, and does not
  102. cause  any enforcer hits so it should be OK on all amigas.
  103.  
  104. Tested on plain A1200, A4000/040, A4000/030/ and an A3000.  I have had reports of it working on the following:-
  105.  
  106.  -> A500 (NTSC)
  107.  -> A2000 030
  108.  
  109. I would be grateful for people to confirm its operation on other machines, e.g. A500+, A2000, etc.
  110.  
  111.  
  112.  
  113.  
  114. Usage
  115.  
  116. This program was designed with one goal in mind, to be simple to use. It is for this reason that the standard "lo
  117. ok"   of the workbench has been used. 
  118.  
  119. The program has three main interface area's. The file list at the top (initialy blank ), the search paameter cont
  120. rol's, contained within the "raised" box, and the program  control functions at  the bottom. 
  121.  
  122. Firstly the Search parameter gadgets  will be described.  
  123.  
  124. The status gadget informs the user of the current status of the program. It is not selectable by the user.
  125.  
  126. The Path gadget, keyboard shortcut P, is used to specify the drive or directory in which to look
  127. for the file. Limiting the search to a particular directory saves time by reducing the number of files which have
  128.  to be searched .  e.g.
  129.  
  130. DH0:
  131.  
  132. This would search all of DH0:,  whereas
  133.  
  134. dh0:utilities/
  135.  
  136. would only search the directory dh0:utilities.
  137.  
  138. A simpler and quicker method to specify a search path is to drag the icon of the disk or directory that
  139. you wish to search on to the FileFinder interface, anywhere will do, and release it.  This will enter the path of
  140. the icon into the path gadget.
  141.  
  142.  
  143. The Pattern gadget, keyboard shortcut T, is used to specify the file for which to search. Standard AmigaDOS file 
  144.  patterns are accepted, to save you digging out your AmigaDOS manual, if you even  have one, here are the pattern
  145.  's
  146.  
  147.  ?               Matches any single character.
  148.  
  149.  #<p>            Matches zero or more occurances of <p>.
  150.  
  151.  <p1>|<p2>       Matches if either <p1> or <p2> matches.
  152.  
  153.  -<p>            Matches everything but <p>.
  154.  
  155.  (<p1><p2>...)   Groups items together.
  156.  
  157.  %               Matches the null string.
  158.  
  159.  [<p>-<p>]       Determines a character range.
  160.  
  161. Now unless you've used AmigaDOS extensivly, that lot will be about as clear as mud. So here's the english translation.
  162.  
  163.  A?B             Matches any three letter word begining in A and ending in B. Such as AcB, AzB, ABB, etc.
  164.  
  165.  A#BC Matches any name beginning in A and ending in C, with any number of B's in between. Such as ABC, ABBC, ABBB
  166.    C, etc.
  167.  
  168.  ABC#?           Matches any name beginning ABC. Such as ABCD, ABCPIC.info, etc.
  169.  
  170.  #?XYZ           Matches any name ending XYZ. Such as MARK_XYZ, PICXYZ, etc.
  171.  
  172.  ABC#?XYZ        Matches any name beginning ABC and ending XYZ. Such as ABCXYZ,  ABCMARKXYZ, etc.
  173.  
  174.  A(B|C)D         Matches ABD or ACD.
  175.  
  176.  ~(XYZ)          Matches anything but XYZ.
  177.  
  178.  ~(#?.info)      Matches anything not ending in .info.
  179.  
  180.  A#(BC) Matches any name begining with A followed by any number of BC's. Such as ABC, ABCBC, ABCBCBC, etc.
  181.  
  182.  A(B|D|%)C Matches any name starting with A ending with C with B, D or nothing in between. Such as ABC, ADC or AC
  183.    .
  184.  
  185.  [A-D]#?         Matches any name beginning with A, B, C or D.
  186.  
  187.  
  188.  
  189. The Size button, keyboard shortcut S, opens the Search Size limit window containing three gadgets. 
  190.  
  191. They are the info gadget, which is a small reminder of what to do, the Max Size gadget, keyboard shortcut M, where the  maximum file size to include in
  192. the search is put, and the M in Size gadget, keyboard shortcut S, where the  minimum file size to incul de
  193. in the search is put. The search size limit window does not have to be closed after use and can be left open.
  194. To ignore a maximum file size limit enter a value of 0. e.g.
  195.  
  196. Max size = 0 Min size = 1000
  197.  
  198. would only look for files over 1000 bytes (1Kb) in size. 
  199.  
  200.                                                    
  201. Max size = 10000 Min size = 5000
  202.  
  203. would only look for files over 5000 bytes (5Kb) long but under 10000 bytes (10 Kb).
  204.  
  205.  
  206. The Date button, keyboard shortcut D, opens the Date Size limit window containing three dadgets.
  207.  
  208. They are the info gadget, which is a small reminder of what to do, the From gadget, keyboard shortcut
  209. F, where the earliest date to include in the search is entered, and the To gadget, keyboard shortcut T, where
  210. the most recent date to include is entered.
  211.   The date range limit window does not have to be closed after use and can be left open.  To ignore a date
  212. limit leave the gadget empty.
  213.  
  214. The date should be entered in a DD-MMM-YY format e.g.
  215.  04-Mar-95, also 04-03-95 works equally well.
  216.  
  217.  
  218. The List Gadget.
  219.  
  220. This is where the list of files that match the search parameters will appear. If the list gadget is clicked on,  
  221.  details of the file selected, will appear in the info window. This provides details such as the creation date of
  222.   the file, its name, the path  to the file and its size. The info window can be left open when selecting
  223. other files, there details will replace those already in the info window. 
  224.  
  225.  
  226. Program control gadgets.
  227.  
  228. Quit, keyboard shortcut Q, exits the program immediately. Warning, you will not be asked to confirm a quit request.
  229.  
  230. Hide, keyboard sortcut H, closes the GUI, but leaves the program running, press the hotkey combination
  231. to popup the interface, default Shift Alt F.
  232.  
  233. Find, keyboard shortcut F, commences the search with the current search parameters.
  234.  
  235. Abort, keyboard shortcut A, aborts the current search operation. This will stop the search at the point it had 
  236. reached  when the  abort button was pressed. Search operations must be allowed to compleat or aborted before any 
  237. other commands can be used, such as Quit.
  238.  
  239. Print, keyboard shortcut R, print's the current contents of the list to the current prefs printer.
  240.  
  241.  
  242. Recommendation
  243.  
  244. To make the search as fast as possible, it is recommended that the program window is kept as small as
  245. possible. It  can easily be enlarged after the search is finished.
  246.  
  247.  
  248.  
  249.  
  250.  
  251. Installation
  252.  
  253. This couldn't possibly be easier.  Simply drag the File Finder icon to wherever you want
  254. it to be put. I would recomend either your utilities drawer, tools drawer or preferbly your WBStartup drawer.
  255.  
  256.  
  257. The documentation consists of the AmigaGuide format doc, and a plain text file.  Also there is also a picture of
  258. the interface this should ideally be kept in the same place as the amigaguide doc.
  259.  
  260. New to version 1.05.
  261.  
  262. TOOLTYPES
  263.  
  264. (See page 10-23 of the WorkBench 3.0 manual.)
  265.  
  266. CX_HOTKEY="ctrl F" or any other combination you want.  This key combination will cause
  267. the program to popup its GUI(Graphical user interface) if it is currently "Hidden".
  268.  
  269. Use the tooltype  DONOTWAIT if you run the program from the WBStartup drawer.
  270.  
  271. The  CX_POPUP tooltype determinew if the program opens its GUI on startup.
  272.  
  273.  
  274.  
  275. Problems
  276.  
  277. One problem that you might experience if you have a particularly deep directory structure, is that of
  278. a stack overflow.  This can be solved by the increasing the stack size of the  program.  See page 3-19 of the
  279. WB3.0 manual for details on how to do this.  
  280.  
  281. If you discover any problems with this program send me the details, such as what the problem is, what sort 
  282. of machine you use machine, you KS and WB version numbers and an address where you can be contacted.
  283.  
  284.  
  285.  
  286. Future plans
  287.  
  288. Immplement the type limit feature.  This my take a while :-(
  289.  
  290. You never know, some shareware subscriptions might encorage me to get these features implemented :->
  291.  
  292. Also I would welcome any suggestions for improvements or new features.
  293.  
  294. Contacts
  295.  
  296.  
  297. Acknowledgements
  298.  
  299. Thanks go to the Amiga Shopper magazine in the UK for providing the inspiration for this program. This program is
  300. loosly based on a program that they ran as a C programming tutorial, but has had considreable enhancements, and
  301. extra features added.
  302.  
  303.  
  304.  
  305. Suggestions/Registration
  306.  
  307. Firstly I can be contacted by Email or snail mail.
  308.  
  309. Email (Bugs, suggestions only)
  310.  
  311. u9326383@radon.sys.uea.ac.uk
  312.  
  313. I will have access to this account until at least summer 1996.
  314.  
  315. Snail mail( registration requests, bugs, suggestions)
  316.  
  317.  Mr M D Melton,  
  318.  1 Hawksmoor close,  
  319.  North Hykeham, 
  320.  Lincoln, 
  321.  England,
  322.  LN6 9PN
  323.  
  324. Registration
  325.  
  326. What benifits will registration bring you.  Well appart from making your pocket/wallet slightly lighter and
  327. slimmer :-),  firstly it will bring my eternal gratitude, and secondly the very latest version of this program,
  328. if you have an email address where I could send it to, or send me a self addessed jiffy bag or similar containing
  329. a DSDD floppy.  What do I ask for this program, which has been written in my spare time while studying for my
  330. degree, as a possible method of suplementing my income :->
  331.  
  332. Registration is the huge figure of £5, yes thats all, just 5 GB pounds.  Sorry but I can only accept GB pounds.
  333. This is because the bank would want its huge slice for changing forign currencies :-<.
  334.